SureTax Returns API
GET Submission Request Status
Overview
This endpoint is used to retrieve the current status of a submission request for a specific form instance. This status provides information about whether the form submission was successful, failed, or is still in progress. It allows users to track the processing state of their form submissions and respond accordingly
OperationId: GET Submission Request Status
Authorization Method(s): OAuth
Verb: GET
End Point: /api/v1/Forms/SubmissionRequestStatus
Query parameters in an API operation are key-value pairs that are included in the URL of an API request to filter or modify the data returned by the API. They come after the `?` in the URL and are often used to pass optional parameters like search terms, pagination information, sorting criteria, or filters to narrow down the data in the response.
| Display String | Field Name | Field Type |
|---|---|---|
| Id* | Id | string |
Overview
Response object for submission status for forms instance.
Example Response
The following is an example response you can expect for this operation
{
"data": [
{
"requestStatus": "1",
"formInstances": [
{
"id": "acf10f21-ccc5-499c-b3e9-e02288c997f0",
"responses": [
{
"status": "SUI",
"timestamp": "2024-01-01 05:40:25",
"message": "ABC",
"responseFileId": "ab1cd227-b009-4cbf-9311-1a49b9523441",
"requestFileId": "47265480-a067-4fc9-9d25-fd1964ad8a67"
}
]
}
]
}
]
}
Response codes in an API indicate the outcome of a request. They are three-digit numbers returned by the server to help the client understand if the request was successful, encountered an error, or needs further action. This operation has the following possible responses.
| code | description |
|---|---|
| 200 | The API response contains the status for a deletion process. Success Response - 200 OK. The API will respond with the current status of the process. |
| 204 | 204 No Content If no records are found for the provided request, the API will respond with a No Content status. |
| 400 | Bad Request - The server could not process the request due to invalid input or missing required parameters. |
| 401 | 401 Unauthorized: The user's authentication is not valid. |
| 500 | Internal Server Error - An unexpected error occurred on the server while processing the request. |